Skip to content

docs: how to write secureblue FAQ section#362

Open
Commenter25 wants to merge 2 commits intosecureblue:livefrom
Commenter25:moniker-meticulousness
Open

docs: how to write secureblue FAQ section#362
Commenter25 wants to merge 2 commits intosecureblue:livefrom
Commenter25:moniker-meticulousness

Conversation

@Commenter25
Copy link
Copy Markdown
Contributor

sacrebleu

@codacy-production
Copy link
Copy Markdown

codacy-production Bot commented May 2, 2026

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@RoyalOughtness
Copy link
Copy Markdown
Contributor

This belongs in the contributing guides/style guides, not user FAQ 😄

@Commenter25
Copy link
Copy Markdown
Contributor Author

I disagree. While it's certainly helpful for contributors, the majority of people I've seen getting this wrong would never open the contributing guide. This is for general people, or even the press, when they don't understand the name. Which I've noticed is fairly often.

@RoyalOughtness
Copy link
Copy Markdown
Contributor

I disagree. While it's certainly helpful for contributors, the majority of people I've seen getting this wrong would never open the contributing guide. This is for general people, or even the press, when they don't understand the name. Which I've noticed is fairly often.

The FAQ is for helping people understand how to use secureblue, not police their spelling 😅

@Commenter25
Copy link
Copy Markdown
Contributor Author

I feel like "police their spelling" is a bit of an extreme description. The "Project information" section has plenty of information that isn't necessarily relevant to secureblue usage, but is still useful information people would want to know about the project. Given the frequency of alternate forms of the name, and the times I've seen people directly expressing uncertainty about the correct way to write it (one of which prompted this PR), I would say this is also useful information people would want to know. Should we remove the "Is secureblue immutable?" section because it polices people's language?

@target6404
Copy link
Copy Markdown

The last sentence (If you wish to be maximally incorrect, you can write "Secure Blue".) is not helpful and should be removed IMO

@Commenter25
Copy link
Copy Markdown
Contributor Author

Fair enough, in hindsight I can see how it'd be misinterpreted as aggressive.

@RoyalOughtness
Copy link
Copy Markdown
Contributor

I feel like "police their spelling" is a bit of an extreme description. The "Project information" section has plenty of information that isn't necessarily relevant to secureblue usage, but is still useful information people would want to know about the project. Given the frequency of alternate forms of the name, and the times I've seen people directly expressing uncertainty about the correct way to write it (one of which prompted this PR), I would say this is also useful information people would want to know. Should we remove the "Is secureblue immutable?" section because it polices people's language?

This isn't about policing language it's about correcting misunderstandings that come with certain descriptions. capitalization of secureblue is not at all analogous to that 😅

@Commenter25
Copy link
Copy Markdown
Contributor Author

Is this not correcting a misunderstanding?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants